Skip to content

Sync Markdown checks with "template" #101

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 16, 2021
Merged

Sync Markdown checks with "template" #101

merged 1 commit into from
Aug 16, 2021

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Aug 14, 2021

We have assembled a collection of reusable project assets:
https://github.com/arduino/tooling-project-assets
These will be used in the repositories of all Arduino tooling projects.

Some improvements and standardizations have been made in the upstream "template" assets for checking the general quality
of Markdown files. Those are introduced to this repository here.

Notable:

  • Make link check task Windows compatible
  • Use markdownlint-cli to check for common problems and style.
  • Bring repository into compliance with the standard Markdown style for Arduino tooling projects

NOTE: the docs:check-links task has been renamed to markdown:check-links for consistency with the standard
"template" task name.

@per1234 per1234 added type: enhancement Proposed improvement topic: infrastructure Related to project infrastructure labels Aug 14, 2021
@per1234 per1234 requested a review from umbynos August 14, 2021 03:47
We have assembled a collection of reusable project assets:
https://github.com/arduino/tooling-project-assets
These will be used in the repositories of all Arduino tooling projects.

Some improvements and standardizations have been made in the upstream "template" assets for checking the general quality
of Mardown files. Those are introduced to this repository here.

Notable:

- Make link check task Windows compatible
- Use markdownlint-cli to check for common problems and style.
- Bring repository into compliance with the standard Markdown style for Arduino tooling projects

NOTE: the `docs:check-links` task has been renamed to `markdown:check-links` for consistency with the standard
"template" task name.
@per1234 per1234 merged commit 5683119 into arduino:main Aug 16, 2021
@per1234 per1234 deleted the sync-check-markdown branch August 16, 2021 10:05
@per1234 per1234 self-assigned this Nov 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: infrastructure Related to project infrastructure type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants